Parameters

Encompass Instance Name

Enter the unique instance that was specified in the **Create Session** command.

Required

Query Method

Specify whether to query for loans using a filter or a list of loan ids.

Required

Filter

Provide the filter for the pipeline query.

Required

Start

Provide the zero-based starting index. The default is zero.

Required

Limit

Provide the maximum number of items to return.

Required

Loan Id(s)

Define the specific loan ids to query.

Required

Include LockInfo

Specify whether to include lock info.

Required

Ignore Invalid Fields

Specify whether to ignore fields that are invalid in the request.

Required

Loan Field Id(s) (Optional)

Define the specific fields to get.

Sort Order (Optional)

Provide the sort order options for the pipeline results.

Organization Type (Optional)

Specify the organization type for the pipeline query.

Loan Ownership (Optional)

Specify the loan ownership for the pipeline query.

Output Results JArray Variable

Create a new variable or select a variable from the list.

Required

Private (Optional)

Optional field to mark the command as private (data sensitive) in order to avoid its logging.

Remote (Optional)

Optional field to mark the command as remote in order to execute it on a remote machine.

Error Handling

Optional field for how to handle errors encountered.

Required

Comment (Optional)

Optional field to enter a custom comment which could potentially describe this command or the need for this command.